## API Report File for "@backstage/plugin-techdocs-backend"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogClient } from '@backstage/catalog-client';
import { Config } from '@backstage/config';
import { DefaultTechDocsCollatorFactory as DefaultTechDocsCollatorFactory_2 } from '@backstage/plugin-search-backend-module-techdocs';
import { DocsBuildStrategy as DocsBuildStrategy_2 } from '@backstage/plugin-techdocs-node';
import { Entity } from '@backstage/catalog-model';
import express from 'express';
import { GeneratorBuilder } from '@backstage/plugin-techdocs-node';
import { Knex } from 'knex';
import { Logger } from 'winston';
import { Permission } from '@backstage/plugin-permission-common';
import { PluginCacheManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
import { PreparerBuilder } from '@backstage/plugin-techdocs-node';
import { PublisherBase } from '@backstage/plugin-techdocs-node';
import type { TechDocsCollatorFactoryOptions as TechDocsCollatorFactoryOptions_2 } from '@backstage/plugin-search-backend-module-techdocs';
import { TechDocsDocument as TechDocsDocument_2 } from '@backstage/plugin-techdocs-node';
import { TokenManager } from '@backstage/backend-common';
import * as winston from 'winston';

// @public
export function createRouter(options: RouterOptions): Promise<express.Router>;

// @public @deprecated
export class DefaultTechDocsCollator {
  // (undocumented)
  protected applyArgsToFormat(
    format: string,
    args: Record<string, string>,
  ): string;
  // (undocumented)
  execute(): Promise<TechDocsDocument_2[]>;
  // (undocumented)
  static fromConfig(
    config: Config,
    options: TechDocsCollatorOptions,
  ): DefaultTechDocsCollator;
  // (undocumented)
  readonly type: string;
  // (undocumented)
  readonly visibilityPermission: Permission;
}

// @public @deprecated (undocumented)
export const DefaultTechDocsCollatorFactory: typeof DefaultTechDocsCollatorFactory_2;

// @public @deprecated (undocumented)
export type DocsBuildStrategy = DocsBuildStrategy_2;

// @public
export type OutOfTheBoxDeploymentOptions = {
  preparers: PreparerBuilder;
  generators: GeneratorBuilder;
  publisher: PublisherBase;
  logger: winston.Logger;
  discovery: PluginEndpointDiscovery;
  database?: Knex;
  config: Config;
  cache: PluginCacheManager;
  docsBuildStrategy?: DocsBuildStrategy_2;
  buildLogTransport?: winston.transport;
  catalogClient?: CatalogClient;
};

// @public
export type RecommendedDeploymentOptions = {
  publisher: PublisherBase;
  logger: winston.Logger;
  discovery: PluginEndpointDiscovery;
  config: Config;
  cache: PluginCacheManager;
  docsBuildStrategy?: DocsBuildStrategy_2;
  buildLogTransport?: winston.transport;
  catalogClient?: CatalogClient;
};

// @public
export type RouterOptions =
  | RecommendedDeploymentOptions
  | OutOfTheBoxDeploymentOptions;

// @public @deprecated (undocumented)
export type ShouldBuildParameters = {
  entity: Entity;
};

// @public @deprecated (undocumented)
export type TechDocsCollatorFactoryOptions = TechDocsCollatorFactoryOptions_2;

// @public
export type TechDocsCollatorOptions = {
  discovery: PluginEndpointDiscovery;
  logger: Logger;
  tokenManager: TokenManager;
  locationTemplate?: string;
  catalogClient?: CatalogApi;
  parallelismLimit?: number;
  legacyPathCasing?: boolean;
};

// @public @deprecated (undocumented)
export type TechDocsDocument = TechDocsDocument_2;

export * from '@backstage/plugin-techdocs-node';
```
